package com.jprocms.module.cms.service.guestbook;

import com.jpro.framework.common.pojo.PageResult;
import com.baomidou.mybatisplus.extension.service.IService;
import com.jprocms.module.cms.controller.admin.guestbook.vo.GuestbookCreateReqVO;
import com.jprocms.module.cms.controller.admin.guestbook.vo.GuestbookPageReqVO;
import com.jprocms.module.cms.controller.admin.guestbook.vo.GuestbookQueryListReqVO;
import com.jprocms.module.cms.controller.admin.guestbook.vo.GuestbookUpdateReqVO;
import com.jprocms.module.cms.dal.dataobject.guestbook.GuestbookDO;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 留言板 Service 接口
 *
 * @author jprocms
 */
public interface GuestbookService extends IService<GuestbookDO> {

    /**
     * 创建留言板
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createGuestbook(@Valid GuestbookCreateReqVO createReqVO);

    /**
     * 更新留言板
     *
     * @param updateReqVO 更新信息
     */
    void updateGuestbook(@Valid GuestbookUpdateReqVO updateReqVO);

    /**
     * 更新留言板
     *
     * @param updateReqVO 更新信息
     */
    void updateGuestbookBatch(@Valid Collection<GuestbookDO> updateDOs);

    /**
     * 删除留言板
     *
     * @param id 编号
     */
    void deleteGuestbook(Long id);

    /**
     * 删除留言板
     *
     * @param id 编号
     */
    void deleteGuestbooks(Collection<Long> ids);


    /**
     * 获得留言板
     *
     * @param id 编号
     * @return 留言板
     */
    GuestbookDO getGuestbook(Long id);

    /**
     * 获得留言板列表
     *
     * @param ids 编号
     * @return 留言板列表
     */
    List<GuestbookDO> getGuestbookList(Collection<Long> ids);

    /**
     * 获得留言板分页
     *
     * @param pageReqVO 分页查询
     * @return 留言板分页
     */
    PageResult<GuestbookDO> getGuestbookPage(GuestbookPageReqVO pageReqVO);

    /**
     * 获得留言板总数
     *
     * @param siteId 站点ID
     * @param status 状态
     * @return
     */
    Long getGuestbookCount(Long siteId, Integer status);

    /**
     * 获得留言板列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 留言板列表
     */
    List<GuestbookDO> getGuestbookList(GuestbookQueryListReqVO exportReqVO);

}
